Documentação - Documentação

post https://billing.iugu.com/api/invoices/{competency_month}/apply_discount

Aplica um desconto na fatura que o cliente tem em aberto (mês corrente)

Aplica um desconto na fatura que o cliente tem em aberto (mês corrente). O desconto é aplicado na fatura atual do app que está fazendo a chamada, no workspace informado.

Permissão necessária: billing:invoices.apply_discount

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables
competency_month Required Type: string Mês de competência no formato YYYY-MM ou 'current' para o mês atual Ex: 2025-04

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Body Required

Content Type: application/json

customer_workspace_id

Required

String

ID do workspace do cliente

Ex: 4fHECmQtLdROI4fDLWMiLd

amount

Required

Number

Valor do desconto a ser aplicado

Ex: 100.5

Example

1
2
3
4
{
  "customer_workspace_id": "4fHECmQtLdROI4fDLWMiLd",
  "amount": 100.5
}

Response

200

Desconto aplicado com sucesso

success

Boolean

Ex: true

applied_discount

Number

Valor do desconto aplicado

Ex: 100.5

Example

1
2
3
4
{
  "success": true,
  "applied_discount": 100.5
}

401

Quando houver erro de autenticação

errors

String

Mensagem de erro

Ex: Authentication Error, check your token and try again

Example

1
2
3
{
  "errors": "Authentication Error, check your token and try again"
}

422

Erro de validação. Possíveis motivos: - ID do workspace inválido ou não fornecido - Valor do desconto inválido (maior que o valor da fatura ou menor/igual a zero)

errors

String

Mensagem de erro

Ex: Cheque o Workspace ID e tente novamente mais tarde

Example

1
2
3
{
  "errors": "Cheque o Workspace ID e tente novamente mais tarde"
}

500

Em caso de erro de servidor ou externo.
Você deve tentar de novo dentro de alguns minutos.

errors

String

Mensagem de erro

Ex: Internal Server Error, please try again later.

Example

1
2
3
{
  "errors": "Internal Server Error, please try again later."
}

Back

Retorna o valor pendente da fatura que o cliente tem em aberto (mês corrente)

Forward

Retorna as faturas para o mês de competência informado